<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>VillageUtils xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/torque/util/VillageUtils.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../org/apache/torque/util/package-summary.html">org.apache.torque.util</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.io.BufferedOutputStream;
<a name="23" href="#23">23</a>  <strong>import</strong> java.io.ByteArrayOutputStream;
<a name="24" href="#24">24</a>  <strong>import</strong> java.io.ObjectOutputStream;
<a name="25" href="#25">25</a>  <strong>import</strong> java.io.OutputStream;
<a name="26" href="#26">26</a>  <strong>import</strong> java.io.Serializable;
<a name="27" href="#27">27</a>  <strong>import</strong> java.math.BigDecimal;
<a name="28" href="#28">28</a>  <strong>import</strong> java.util.Hashtable;
<a name="29" href="#29">29</a>  <strong>import</strong> java.util.Iterator;
<a name="30" href="#30">30</a>  <strong>import</strong> java.util.Map;
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="33" href="#33">33</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="34" href="#34">34</a>  <strong>import</strong> org.apache.torque.om.SimpleKey;
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>  <strong>import</strong> com.workingdogs.village.QueryDataSet;
<a name="37" href="#37">37</a>  <strong>import</strong> com.workingdogs.village.Record;
<a name="38" href="#38">38</a>  <strong>import</strong> com.workingdogs.village.TableDataSet;
<a name="39" href="#39">39</a>  
<a name="40" href="#40">40</a>  <em>/**<em>*</em></em>
<a name="41" href="#41">41</a>  <em> * Some Village related code factored out of the BasePeer.</em>
<a name="42" href="#42">42</a>  <em> *</em>
<a name="43" href="#43">43</a>  <em> * @author &lt;a href="<a href="mailto:hps@intermeta.de" target="alexandria_uri">mailto:hps@intermeta.de</a>">Henning P. Schmiedehausen&lt;/a></em>
<a name="44" href="#44">44</a>  <em> * @version $Id: VillageUtils.java 476550 2006-11-18 16:08:37Z tfischer $</em>
<a name="45" href="#45">45</a>  <em> */</em>
<a name="46" href="#46">46</a>  <strong>public</strong> <strong>final</strong> <strong>class</strong> <a href="../../../../org/apache/torque/util/VillageUtils.html">VillageUtils</a>
<a name="47" href="#47">47</a>  {
<a name="48" href="#48">48</a>      <em>/**<em>* The log. */</em></em>
<a name="49" href="#49">49</a>      <strong>private</strong> <strong>static</strong> Log log = LogFactory.getLog(VillageUtils.<strong>class</strong>);
<a name="50" href="#50">50</a>  
<a name="51" href="#51">51</a>      <em>/**<em>*</em></em>
<a name="52" href="#52">52</a>  <em>     * Private constructor to prevent instantiation.</em>
<a name="53" href="#53">53</a>  <em>     *</em>
<a name="54" href="#54">54</a>  <em>     * Class contains only static method ans should therefore not be</em>
<a name="55" href="#55">55</a>  <em>     * instantiated.</em>
<a name="56" href="#56">56</a>  <em>     */</em>
<a name="57" href="#57">57</a>      <strong>private</strong> <a href="../../../../org/apache/torque/util/VillageUtils.html">VillageUtils</a>()
<a name="58" href="#58">58</a>      {
<a name="59" href="#59">59</a>      }
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>      <em>/**<em>*</em></em>
<a name="62" href="#62">62</a>  <em>     * Convenience Method to close a Table Data Set without</em>
<a name="63" href="#63">63</a>  <em>     * Exception check.</em>
<a name="64" href="#64">64</a>  <em>     *</em>
<a name="65" href="#65">65</a>  <em>     * @param tds A TableDataSet</em>
<a name="66" href="#66">66</a>  <em>     */</em>
<a name="67" href="#67">67</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>void</strong> close(<strong>final</strong> TableDataSet tds)
<a name="68" href="#68">68</a>      {
<a name="69" href="#69">69</a>          <strong>if</strong> (tds != <strong>null</strong>)
<a name="70" href="#70">70</a>          {
<a name="71" href="#71">71</a>              <strong>try</strong>
<a name="72" href="#72">72</a>              {
<a name="73" href="#73">73</a>                  tds.close();
<a name="74" href="#74">74</a>              }
<a name="75" href="#75">75</a>              <strong>catch</strong> (Exception ignored)
<a name="76" href="#76">76</a>              {
<a name="77" href="#77">77</a>                  log.debug(<span class="string">"Caught exception when closing a TableDataSet"</span>,
<a name="78" href="#78">78</a>                          ignored);
<a name="79" href="#79">79</a>              }
<a name="80" href="#80">80</a>          }
<a name="81" href="#81">81</a>      }
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <em>/**<em>*</em></em>
<a name="84" href="#84">84</a>  <em>     * Convenience Method to close a Table Data Set without</em>
<a name="85" href="#85">85</a>  <em>     * Exception check.</em>
<a name="86" href="#86">86</a>  <em>     *</em>
<a name="87" href="#87">87</a>  <em>     * @param qds A TableDataSet</em>
<a name="88" href="#88">88</a>  <em>     */</em>
<a name="89" href="#89">89</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>void</strong> close(<strong>final</strong> QueryDataSet qds)
<a name="90" href="#90">90</a>      {
<a name="91" href="#91">91</a>          <strong>if</strong> (qds != <strong>null</strong>)
<a name="92" href="#92">92</a>          {
<a name="93" href="#93">93</a>              <strong>try</strong>
<a name="94" href="#94">94</a>              {
<a name="95" href="#95">95</a>                  qds.close();
<a name="96" href="#96">96</a>              }
<a name="97" href="#97">97</a>              <strong>catch</strong> (Exception ignored)
<a name="98" href="#98">98</a>              {
<a name="99" href="#99">99</a>                  log.debug(<span class="string">"Caught exception when closing a QueryDataSet"</span>,
<a name="100" href="#100">100</a>                         ignored);
<a name="101" href="#101">101</a>             }
<a name="102" href="#102">102</a>         }
<a name="103" href="#103">103</a>     }
<a name="104" href="#104">104</a> 
<a name="105" href="#105">105</a>     <em>/**<em>*</em></em>
<a name="106" href="#106">106</a> <em>     * Convenience Method to close an Output Stream without</em>
<a name="107" href="#107">107</a> <em>     * Exception check.</em>
<a name="108" href="#108">108</a> <em>     *</em>
<a name="109" href="#109">109</a> <em>     * @param os An OutputStream</em>
<a name="110" href="#110">110</a> <em>     */</em>
<a name="111" href="#111">111</a>     <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>void</strong> close(<strong>final</strong> OutputStream os)
<a name="112" href="#112">112</a>     {
<a name="113" href="#113">113</a>         <strong>try</strong>
<a name="114" href="#114">114</a>         {
<a name="115" href="#115">115</a>             <strong>if</strong> (os != <strong>null</strong>)
<a name="116" href="#116">116</a>             {
<a name="117" href="#117">117</a>                 os.close();
<a name="118" href="#118">118</a>             }
<a name="119" href="#119">119</a>         }
<a name="120" href="#120">120</a>         <strong>catch</strong> (Exception ignored)
<a name="121" href="#121">121</a>         {
<a name="122" href="#122">122</a>             log.debug(<span class="string">"Caught exception when closing an OutputStream"</span>,
<a name="123" href="#123">123</a>                     ignored);
<a name="124" href="#124">124</a>         }
<a name="125" href="#125">125</a>     }
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>     <em>/**<em>*</em></em>
<a name="128" href="#128">128</a> <em>     * Converts a hashtable to a byte array for storage/serialization.</em>
<a name="129" href="#129">129</a> <em>     *</em>
<a name="130" href="#130">130</a> <em>     * @param hash The Hashtable to convert.</em>
<a name="131" href="#131">131</a> <em>     * @return A byte[] with the converted Hashtable.</em>
<a name="132" href="#132">132</a> <em>     * @throws Exception If an error occurs.</em>
<a name="133" href="#133">133</a> <em>     */</em>
<a name="134" href="#134">134</a>     <strong>public</strong> <strong>static</strong> <strong>final</strong> byte[] hashtableToByteArray(<strong>final</strong> Hashtable hash)
<a name="135" href="#135">135</a>         throws Exception
<a name="136" href="#136">136</a>     {
<a name="137" href="#137">137</a>         Hashtable saveData = <strong>new</strong> Hashtable(hash.size());
<a name="138" href="#138">138</a>         byte[] byteArray = <strong>null</strong>;
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>         Iterator keys = hash.entrySet().iterator();
<a name="141" href="#141">141</a>         <strong>while</strong> (keys.hasNext())
<a name="142" href="#142">142</a>         {
<a name="143" href="#143">143</a>             Map.Entry entry = (Map.Entry) keys.next();
<a name="144" href="#144">144</a>             <strong>if</strong> (entry.getValue() instanceof Serializable)
<a name="145" href="#145">145</a>             {
<a name="146" href="#146">146</a>                 saveData.put(entry.getKey(), entry.getValue());
<a name="147" href="#147">147</a>             }
<a name="148" href="#148">148</a>         }
<a name="149" href="#149">149</a> 
<a name="150" href="#150">150</a>         ByteArrayOutputStream baos = <strong>null</strong>;
<a name="151" href="#151">151</a>         BufferedOutputStream bos = <strong>null</strong>;
<a name="152" href="#152">152</a>         ObjectOutputStream out = <strong>null</strong>;
<a name="153" href="#153">153</a>         <strong>try</strong>
<a name="154" href="#154">154</a>         {
<a name="155" href="#155">155</a>             <em class="comment">// These objects are closed in the finally.</em>
<a name="156" href="#156">156</a>             baos = <strong>new</strong> ByteArrayOutputStream();
<a name="157" href="#157">157</a>             bos = <strong>new</strong> BufferedOutputStream(baos);
<a name="158" href="#158">158</a>             out = <strong>new</strong> ObjectOutputStream(bos);
<a name="159" href="#159">159</a> 
<a name="160" href="#160">160</a>             out.writeObject(saveData);
<a name="161" href="#161">161</a> 
<a name="162" href="#162">162</a>             out.flush();
<a name="163" href="#163">163</a>             bos.flush();
<a name="164" href="#164">164</a>             baos.flush();
<a name="165" href="#165">165</a>             byteArray = baos.toByteArray();
<a name="166" href="#166">166</a>         }
<a name="167" href="#167">167</a>         <strong>finally</strong>
<a name="168" href="#168">168</a>         {
<a name="169" href="#169">169</a>             close(out);
<a name="170" href="#170">170</a>             close(bos);
<a name="171" href="#171">171</a>             close(baos);
<a name="172" href="#172">172</a>         }
<a name="173" href="#173">173</a>         <strong>return</strong> byteArray;
<a name="174" href="#174">174</a>     }
<a name="175" href="#175">175</a> 
<a name="176" href="#176">176</a>     <em>/**<em>*</em></em>
<a name="177" href="#177">177</a> <em>     * Factored out setting of a Village Record column from a Criteria Key</em>
<a name="178" href="#178">178</a> <em>     *</em>
<a name="179" href="#179">179</a> <em>     * @param crit The Criteria</em>
<a name="180" href="#180">180</a> <em>     * @param key The Criterion Key</em>
<a name="181" href="#181">181</a> <em>     * @param rec The Village Record</em>
<a name="182" href="#182">182</a> <em>     * @param colName The name of the Column in the Record</em>
<a name="183" href="#183">183</a> <em>     */</em>
<a name="184" href="#184">184</a>     <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>void</strong> setVillageValue(<strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> crit,
<a name="185" href="#185">185</a>             <strong>final</strong> String key,
<a name="186" href="#186">186</a>             <strong>final</strong> Record rec,
<a name="187" href="#187">187</a>             <strong>final</strong> String colName)
<a name="188" href="#188">188</a>             throws Exception
<a name="189" href="#189">189</a>     {
<a name="190" href="#190">190</a>         <em class="comment">// A village Record.setValue( String, Object ) would</em>
<a name="191" href="#191">191</a>         <em class="comment">// be nice here.</em>
<a name="192" href="#192">192</a>         Object obj = crit.getValue(key);
<a name="193" href="#193">193</a>         <strong>if</strong> (obj instanceof SimpleKey)
<a name="194" href="#194">194</a>         {
<a name="195" href="#195">195</a>             obj = ((SimpleKey) obj).getValue();
<a name="196" href="#196">196</a>         }
<a name="197" href="#197">197</a>         <strong>if</strong> (obj == <strong>null</strong>)
<a name="198" href="#198">198</a>         {
<a name="199" href="#199">199</a>             rec.setValueNull(colName);
<a name="200" href="#200">200</a>         }
<a name="201" href="#201">201</a>         <strong>else</strong> <strong>if</strong> (obj instanceof String)
<a name="202" href="#202">202</a>         {
<a name="203" href="#203">203</a>             rec.setValue(colName, (String) obj);
<a name="204" href="#204">204</a>         }
<a name="205" href="#205">205</a>         <strong>else</strong> <strong>if</strong> (obj instanceof Integer)
<a name="206" href="#206">206</a>         {
<a name="207" href="#207">207</a>             rec.setValue(colName,
<a name="208" href="#208">208</a>                     crit.getInt(key));
<a name="209" href="#209">209</a>         }
<a name="210" href="#210">210</a>         <strong>else</strong> <strong>if</strong> (obj instanceof BigDecimal)
<a name="211" href="#211">211</a>         {
<a name="212" href="#212">212</a>             rec.setValue(colName, (BigDecimal) obj);
<a name="213" href="#213">213</a>         }
<a name="214" href="#214">214</a>         <strong>else</strong> <strong>if</strong> (obj instanceof Boolean)
<a name="215" href="#215">215</a>         {
<a name="216" href="#216">216</a>             rec.setValue(colName,
<a name="217" href="#217">217</a>                     ((Boolean) obj).booleanValue());
<a name="218" href="#218">218</a>         }
<a name="219" href="#219">219</a>         <strong>else</strong> <strong>if</strong> (obj instanceof java.util.Date)
<a name="220" href="#220">220</a>         {
<a name="221" href="#221">221</a>             rec.setValue(colName,
<a name="222" href="#222">222</a>                     (java.util.Date) obj);
<a name="223" href="#223">223</a>         }
<a name="224" href="#224">224</a>         <strong>else</strong> <strong>if</strong> (obj instanceof Float)
<a name="225" href="#225">225</a>         {
<a name="226" href="#226">226</a>             rec.setValue(colName,
<a name="227" href="#227">227</a>                     crit.getFloat(key));
<a name="228" href="#228">228</a>         }
<a name="229" href="#229">229</a>         <strong>else</strong> <strong>if</strong> (obj instanceof Double)
<a name="230" href="#230">230</a>         {
<a name="231" href="#231">231</a>             rec.setValue(colName,
<a name="232" href="#232">232</a>                     crit.getDouble(key));
<a name="233" href="#233">233</a>         }
<a name="234" href="#234">234</a>         <strong>else</strong> <strong>if</strong> (obj instanceof Byte)
<a name="235" href="#235">235</a>         {
<a name="236" href="#236">236</a>             rec.setValue(colName,
<a name="237" href="#237">237</a>                     ((Byte) obj).byteValue());
<a name="238" href="#238">238</a>         }
<a name="239" href="#239">239</a>         <strong>else</strong> <strong>if</strong> (obj instanceof Long)
<a name="240" href="#240">240</a>         {
<a name="241" href="#241">241</a>             rec.setValue(colName,
<a name="242" href="#242">242</a>                     crit.getLong(key));
<a name="243" href="#243">243</a>         }
<a name="244" href="#244">244</a>         <strong>else</strong> <strong>if</strong> (obj instanceof Short)
<a name="245" href="#245">245</a>         {
<a name="246" href="#246">246</a>             rec.setValue(colName,
<a name="247" href="#247">247</a>                     ((Short) obj).shortValue());
<a name="248" href="#248">248</a>         }
<a name="249" href="#249">249</a>         <strong>else</strong> <strong>if</strong> (obj instanceof Hashtable)
<a name="250" href="#250">250</a>         {
<a name="251" href="#251">251</a>             rec.setValue(colName,
<a name="252" href="#252">252</a>                     hashtableToByteArray((Hashtable) obj));
<a name="253" href="#253">253</a>         }
<a name="254" href="#254">254</a>         <strong>else</strong> <strong>if</strong> (obj instanceof byte[])
<a name="255" href="#255">255</a>         {
<a name="256" href="#256">256</a>             rec.setValue(colName, (byte[]) obj);
<a name="257" href="#257">257</a>         }
<a name="258" href="#258">258</a>     }
<a name="259" href="#259">259</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

